Skip to content

Add 2 issue templates#1

Open
gitauto-ai[bot] wants to merge 2 commits intomainfrom
gitauto/add-issue-templates-c9c97997-508c-4157-a1ab-b8780e3d7c2a
Open

Add 2 issue templates#1
gitauto-ai[bot] wants to merge 2 commits intomainfrom
gitauto/add-issue-templates-c9c97997-508c-4157-a1ab-b8780e3d7c2a

Conversation

@gitauto-ai
Copy link
Contributor

@gitauto-ai gitauto-ai bot commented Mar 11, 2025 •
edited
Loading

Why is this feature needed?

We needed to improve the issue reporting process by adding dedicated issue templates that help our community provide all necessary details when reporting bugs or suggesting features. This creates consistency in the information submitted, making it easier to diagnose and prioritize issues.

What and how are we changing? Why this approach?

This pull request introduces two new issue templates:

  • A Bug Report template (.github/ISSUE_TEMPLATE/bug_report.yml) that prompts users to provide detailed information about any bugs including behavior, logs, steps to reproduce, device details, and more.
  • A Feature Request template (.github/ISSUE_TEMPLATE/feature_request.yml) that assists users in expressing the problem they are facing, their current workarounds, and a proposed solution.

Both templates are designed with clear labels, descriptions, and validations to ensure that key information is collected from the outset. This structured approach will reduce back-and-forth clarifications with users and streamline our troubleshooting and feature enhancement processes.

What actions are required from users?

Users will now see these templates as options when creating new issues:

  • For bugs, they should follow the Bug Report template guidelines.
  • For feature suggestions, they can use the Feature Request template.
    No additional user configuration is needed on our part.

How does it work? (Technical details)

  • The Markdown YAML files are placed in the .github/ISSUE_TEMPLATE folder.
  • Each template defines a set of fields using standardized GitHub issue forms syntax.
  • Fields include text areas and input fields with validations for critical information.
  • Labels are auto-assigned (e.g., "bug", "enhancement", "gitauto") to help with issue categorization.

Is it backwards compatible?

Yes, these changes are fully backwards compatible. They only affect new issue submissions and do not alter any existing functionalities of the repository.

Any other considerations?

  • We reviewed our internal issue tracking requirements to decide on the fields necessary for each template.
  • Future improvements might include additional fields or clarifications based on user feedback.
  • These templates can serve as a foundation for further automation or integration with our project management tools.

@gitauto-ai gitauto-ai bot requested a review from browser-vm March 11, 2025 11:59
@sourcery-ai
Copy link

sourcery-ai bot commented Mar 11, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request introduces two new issue templates to the repository: 'bug_report.yml' and 'feature_request.yml'. These templates provide structured forms for users to submit bug reports and feature requests, respectively. Each template defines a set of input fields with specific types, labels, descriptions, and validations to guide users in providing the necessary information.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added a bug report issue template.
  • Created a 'bug_report.yml' file.
  • Defined the template's name, description, title format, and labels.
  • Configured various input fields for describing the bug, including 'Bug Behavior', 'Logs', 'Screenshots', 'When It Occurred', 'Steps to Reproduce', 'Expected Behavior', 'Possible Cause', 'Device', 'OS', 'Browser', and 'Additional Information'.
  • Specified input types (textarea, input), validations (required, false), labels, descriptions, and placeholders for each field.
 .github/ISSUE_TEMPLATE/bug_report.yml
Added a feature request issue template.
  • Created a 'feature_request.yml' file.
  • Defined the template's name, description, title format, and labels.
  • Configured input fields for describing the feature request, including 'Problem', 'Current Solution', 'Proposed Solution', 'Attachments', and 'Additional Information'.
  • Specified input types (textarea), validations (required, false), labels, descriptions, and placeholders for each field.
 .github/ISSUE_TEMPLATE/feature_request.yml
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai bot reviewed Mar 11, 2025
View reviewed changes
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have skipped reviewing this pull request. It seems to have been created by a bot (hey, gitauto-ai[bot]!). We assume it knows what it's doing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

@browser-vm browser-vm Awaiting requested review from browser-vm

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

0 participants